/******************************************************************************
 * Copyright (C) 2024 EternalChip, Inc.(Gmbh) or its affiliates.
 * 
 * All Rights Reserved.
 * 
 * @file bsp_led.h
 * 
 * @par dependencies 
 * - stdio.h
 * - stdint.h
 * 
 * @author Cuihan
 * 
 * @brief Provide the HAL APIs of AHT21 and corresponding opetions.
 * 
 * Processing flow:
 * 
 * call directly.
 * 
 * @version V1.0 2024-12-24
 *
 * @note 1 tab == 4 spaces!
 * 
 *****************************************************************************/

#ifndef __BSP_LED_H__  //Avoid repeated including same files later
#define __BSP_LED_H__

//******************************** Includes *********************************//

#include <stdint.h>               // 编译器提供的通用库包含部分
#include <stdio.h>

#include "cmsis_os.h"             // core os implementation
#include "queue.h"

//******************************** Includes *********************************//

//*********************Thread_Func **********************//
extern osThreadId_t led_TaskHandle;
extern const osThreadAttr_t led_Task_attributes;
//*********************Thread_Func **********************//

//*********************Queue_Handler ********************//
extern QueueHandle_t led_queue;

//*********************Queue_Handler ********************//


typedef enum
{
  LED_OK                = 0,            /* Operation completed successfully.  */
  LED_ERROR             = 1,            /* Run-time error without case matched*/
  LED_ERRORTIMEOUT      = 2,            /* Operation failed with timeout      */
  LED_ERRORRESOURCE     = 3,            /* Resource not available.            */
  LED_ERRORPARAMETER    = 4,            /* Parameter error.                   */
  LED_ERRORNOMEMORY     = 5,            /* Out of memory.                     */
  LED_ERRORISR          = 6,            /* Not allowed in ISR context         */
  LED_RESERVED          = 0x7FFFFFFF    /* Reserved                           */
} led_status_t;

typedef enum
{
  LED_ON                = 0,            /* Operation LED ON.                  */
  LED_OFF               = 1,            /* Run-time error without case matched*/
  LED_TOGGLE            = 2,            /* Operation LED toggle.             */
} led_operation_t;

//******************************** Declaring ********************************//

/**
 * @brief Instantiates the bsp_led_handler_t target.
 * 
 * Steps:
 *  1.doing the specific operations
 *  
 * @param[in] void 
 * 
 * @return led_handler_status_t : Status of the function.
 * 
 * */
led_status_t led_operate(led_operation_t led_operation);


/**
 * @brief led_task_func for thread to run.
 * 
 * Steps:
 *  1.doing the specific operations
 *  
 * @param[in] void 
 * 
 * @return led_handler_status_t : Status of the function.
 * 
 * */
void         led_task_func                 (void *argument);
//******************************** Declaring ********************************//

#endif // __BSP_LED_H__